/*
 * Copyright 2012-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.jackson;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.KeyDeserializer;

import org.springframework.core.annotation.AliasFor;
import org.springframework.stereotype.Component;

/**
 * {@link Component @Component} 注解，用于提供 {@link JsonSerializer}、
 * {@link JsonDeserializer} 或 {@link KeyDeserializer} 的实现类，
 * 当使用 {@link JsonComponentModule} 时这些实现类会被注册到 Jackson 中。
 * 可以用于直接注解实现类，或者注解包含这些实现类作为内部类的类。
 * 例如：
 * <pre class="code">
 * &#064;JsonComponent
 * public class CustomerJsonComponent {
 *
 *     public static class Serializer extends JsonSerializer&lt;Customer&gt; {
 *
 *         // ...
 *
 *     }
 *
 *     public static class Deserializer extends JsonDeserializer&lt;Customer&gt; {
 *
 *         // ...
 *
 *     }
 *
 * }
 *
 * </pre>
 *
 * @see JsonComponentModule
 * @since 1.4.0
 * @author Phillip Webb
 * @author Paul Aly
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface JsonComponent {

	/**
	 * 该值可以表示逻辑组件名称的建议，在自动检测组件的情况下将转换为 Spring bean。
	 *
	 * @return 组件名称
	 */
	@AliasFor(annotation = Component.class)
	String value() default "";

	/**
	 * 由提供的序列化器/反序列化器处理的类型。对于 {@link KeyDeserializer}，
	 * 此属性是必需的，因为无法推断类型。对于 {@link JsonSerializer} 或
	 * {@link JsonDeserializer}，它可以用于限制处理从泛型推断的类型的子类。
	 *
	 * @return 应由组件处理的类型
	 * @since 2.2.0
	 */
	Class<?>[] type() default {};

	/**
	 * 序列化器/反序列化器应在模块中注册的作用域。
	 *
	 * @return 组件的处理类型
	 * @since 2.2.0
	 */
	Scope scope() default Scope.VALUES;

	/**
	 * 序列化器/反序列化器可以注册的各种作用域。
	 */
	enum Scope {

		/**
		 * 用于常规值内容的序列化器/反序列化器。
		 *
		 * @see JsonSerializer
		 * @see JsonDeserializer
		 */
		VALUES,

		/**
		 * 用于键的序列化器/反序列化器。
		 *
		 * @see JsonSerializer
		 * @see KeyDeserializer
		 */
		KEYS

	}

}
